/*
 * gybon - Core modules for Google Yahoo Rich Application Framework
 *
 * Copyright (c) 2009, Yves Cuillerdier
 * All rights reserved.
 * 
 * This software is licensed under the new BSD License:
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * @version 0.2.0
 */
package gyraf.wrapper.client;

import gyraf.wrapper.client.misc.JsUtil;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * A configuration object. A configuraion object is an associative map of
 * name/value pair.
 * <p>
 * Values could be string, numbers, true, false, object or array
 */
public class JsConfiguration {

	/** The configuration object */
	private final JavaScriptObject config = JavaScriptObject.createObject();

	/**
	 * Create a new configuration object.
	 */
	public JsConfiguration() {
		super();
	}

	/**
	 * Get the configuration as a JavaScriptObject.
	 * 
	 * @return the configuration as a JavaScriptObject
	 */
	public JavaScriptObject getJsElement() {
		return config;
	}

	/**
	 * Get the configuration object string
	 * 
	 * @return the configuration as a String
	 */
	@Override
	public String toString() {
		return JsUtil.toString(config);
	}

	// //////////////////////////////////////////////////////////////
	// Set properties
	// ////////////////////////////////////////////////////////////
	/**
	 * add/set a boolean property.
	 * 
	 * @param option
	 *            the property name
	 * @param val
	 *            the property value
	 */
	public final native JsConfiguration setProp(final String option, final boolean val) /*-{
		var attr = this.@gyraf.wrapper.client.JsConfiguration::config;
		attr[option] = val;
		return this;
	}-*/;

	/**
	 * add/set an integer property.
	 * 
	 * @param option
	 *            the property name
	 * @param val
	 *            the property value
	 */
	public final native JsConfiguration setProp(final String option, final int val) /*-{
		var attr = this.@gyraf.wrapper.client.JsConfiguration::config;
		attr[option] = val;
		return this;
	}-*/;

	/**
	 * add/set a double property.
	 * 
	 * @param option
	 *            the property name
	 * @param val
	 *            the property value
	 */
	public final native JsConfiguration setProp(final String option, final double val) /*-{
		var attr = this.@gyraf.wrapper.client.JsConfiguration::config;
		attr[option] = val;
		return this;
	}-*/;

	/**
	 * add/set a String property.
	 * 
	 * @param option
	 *            the property name
	 * @param val
	 *            the property value
	 */
	public final native JsConfiguration setProp(final String option, final String val) /*-{
		var attr = this.@gyraf.wrapper.client.JsConfiguration::config;
		attr[option] = val;
		return this;
	}-*/;

	/**
	 * add/set an Object property.
	 * 
	 * @param option
	 *            the property name
	 * @param val
	 *            the property value
	 */
	public final native JsConfiguration setProp(final String option,
			final JavaScriptObject val) /*-{
		var attr = this.@gyraf.wrapper.client.JsConfiguration::config;
		attr[option] = val;
		return this;
	}-*/;
}
